1 /*
2 * Copyright 2005 Arnaud Prost
3 *
4 * Arnaud.prost@gmail.com
5 *
6 * This software is a computer program whose purpose is to ease the
7 * management of software project.
8 *
9 * This software is governed by the CeCILL license under French law and
10 * abiding by the rules of distribution of free software. You can use,
11 * modify and/ or redistribute the software under the terms of the CeCILL
12 * license as circulated by CEA, CNRS and INRIA at the following URL
13 * "http://www.cecill.info".
14 *
15 * As a counterpart to the access to the source code and rights to copy,
16 * modify and redistribute granted by the license, users are provided only
17 * with a limited warranty and the software's author, the holder of the
18 * economic rights, and the successive licensors have only limited
19 * liability.
20 *
21 * In this respect, the user's attention is drawn to the risks associated
22 * with loading, using, modifying and/or developing or reproducing the
23 * software by the user in light of its specific status of free software,
24 * that may mean that it is complicated to manipulate, and that also
25 * therefore means that it is reserved for developers and experienced
26 * professionals having in-depth computer knowledge. Users are therefore
27 * encouraged to load and test the software's suitability as regards their
28 * requirements in conditions enabling the security of their systems and/or
29 * data to be ensured and, more generally, to use and operate it in the
30 * same conditions as regards security.
31 *
32 * The fact that you are presently reading this means that you have had
33 * knowledge of the CeCILL license and that you accept its terms.
34 */
35
36 package net.sf.pmr.agilePlanning.domain.story;
37
38 import java.util.Set;
39
40 import net.sf.pmr.agilePlanning.domain.iteration.Iteration;
41 import net.sf.pmr.core.domain.basicProject.BasicProject;
42 import net.sf.pmr.keopsframework.domain.object.DomainObject;
43
44 /***
45 * @author Arnaud Prost (arnaud.prost@gmail.com)
46 *
47 * A story is a customer requirement.
48 */
49 public interface Story extends DomainObject {
50
51 /***
52 * short description <br>
53 * i.e.: display, compute ...
54 * @return shortDescription
55 */
56 String getShortDescription();
57
58 /***
59 * short description
60 * @param shortDescription short description
61 */
62 void setShortDescription(final String shortDescription);
63
64 /***
65 * description
66 * @return description
67 */
68 String getDescription();
69
70 /***
71 * description
72 * @param description description
73 */
74 void setDescription(final String description);
75
76 /***
77 * first estimate
78 * @return first estimate
79 */
80 int getEstimate();
81
82 /***
83 * first estimate
84 * @param estimate : first estimate
85 */
86 void setEstimate(final int estimate);
87
88 /***
89 * Itetation of the story
90 * @return Itetation of the story
91 */
92 Iteration getIteration();
93
94 /***
95 * Itetation of the story
96 * @param iteration of the story
97 */
98 void setIteration(final Iteration iteration);
99
100 /***
101 * tasks fot the story
102 * @return tasks
103 */
104 Set getTasks();
105
106 /***
107 * tasks fot the story
108 * @param tasks tasks
109 */
110 void setTasks(final Set tasks);
111
112 /***
113 * basic project
114 * @return basic project
115 */
116 BasicProject getBasicProject();
117
118 /***
119 * basic project
120 * @param basicProject basic project
121 */
122 void setBasicProject(final BasicProject basicProject);
123
124 }